Skip to content

Snowflake plugin#40

Open
richbenwell wants to merge 4 commits intomainfrom
work/rb/snowflake
Open

Snowflake plugin#40
richbenwell wants to merge 4 commits intomainfrom
work/rb/snowflake

Conversation

@richbenwell
Copy link
Copy Markdown
Contributor

🔌 Plugin overview

  • Plugin name: Snowflake
  • Purpose / problem solved: Query data from a Snowflake database via Snowflake SQL API
  • Primary audience (e.g. platform teams, SREs, product teams): Anyone
  • Authentication method(s) (e.g. OAuth, Username/Password, API Key): OAuth

🖼️ Plugin screenshots

Plugin configuration

image

Default dashboards

None


🧪 Testing

Tested against a Snowflake Standard on AWS.


⚠️ Known limitations

Supports just a single SQL Query data stream that connects to the Snowflake SQL API. No other Snowflake REST APIs supported.


📚 Checklist

  • Plugin, datastream and UI naming follow SquaredUp guidelines
  • Logo added
  • [n/a] One or more dashboards added
  • README added including configuration guidance
  • No secrets or credentials included
  • I agree to the Code of Conduct

Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a new plugin with several documentation issues already flagged inline, plus author.type is set to "labs" rather than "community" as required by guidelines — worth a human look to confirm that's intentional.

Extended reasoning...

Overview\nThis PR introduces a brand-new Snowflake plugin, adding 8 files: metadata.json, ui.json, configValidation.json, a SQL query data stream (with post-processing script), an SVG icon, README, and a setup guide. It is a self-contained plugin directory with no changes to existing files.\n\n### Security risks\nThe plugin uses OAuth 2.0 with auth code grant, which is the appropriate authentication pattern. The OAuth client secret is handled via a password field and the oauth2ClientSecretLocationDuringAuth: header setting. No hardcoded secrets or credentials are present. The SQL query data stream passes user-supplied SQL directly to Snowflake's SQL API — this is inherent to the plugin's purpose and consistent with other SQL-based plugins in the repo.\n\n### Level of scrutiny\nNew plugin PRs warrant human review regardless of bug count. The inline bug comments cover several documentation nits (typo, copy-paste errors, heading convention violations), but there is one additional concern not covered by inline comments: metadata.json sets author.type to "labs" and author.name to "SquaredUp Labs". The repo guidelines state author.type should always be "community". This may be intentional for a SquaredUp-internal plugin, but a human should confirm.\n\n### Other factors\nNo CODEOWNERS entry is added for this plugin directory, which the guidelines encourage for new plugins. The multiple documentation issues (4 nits) suggest the docs could use a polish pass before merging.

Comment thread plugins/Snowflake/v1/docs/setup.md
Comment thread plugins/Snowflake/v1/docs/setup.md
Comment thread plugins/Snowflake/v1/README.md Outdated
Comment thread plugins/Snowflake/v1/docs/setup.md
@clarkd clarkd added the new-plugin Used to PR newly added plugins label Apr 20, 2026
@github-actions
Copy link
Copy Markdown

🧩 Plugin PR Summary

📦 Modified Plugins

  • plugins/Snowflake/v1

📋 Results

Step Status
Validation ✅ Passed
Deployment 🚀 Deployed

🔍 Validation Details

snowflake
{
  "valid": true,
  "pluginName": "snowflake",
  "pluginType": "hybrid",
  "summary": {
    "Data Streams": 1,
    "Import Definitions": 0,
    "UI Configuration": true,
    "Has Icon": true,
    "Has Default Content": false,
    "Config Validation": true,
    "Custom Types": false
  }
}

@gdorward
Copy link
Copy Markdown

Hey @richbenwell , do we have any credentials for testing this one or is it easy enough for someone to set up their own instance? I'm not familiar with the tool at all

Copy link
Copy Markdown
Member

@clarkd clarkd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General structure and JSON looks good - deferring to @gdorward for any testing/validation

@clarkd clarkd requested a review from a team April 24, 2026 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-plugin Used to PR newly added plugins

Development

Successfully merging this pull request may close these issues.

3 participants